Mobile Payments SDK Android Technical Reference/com.squareup.sdk.mobilepayments.cardreader

Package-level declarations

Classes to connect and manage a set of Square Readers.

Types

CardEntryMethod

enum CardEntryMethod : Enum<CardEntryMethod>

Methods of payments that might be supported by readers.

PairingErrorCode

enum PairingErrorCode : Enum<PairingErrorCode> , ErrorCode

Error conditions that arise when pairing readers.

PairingHandle

interface PairingHandle

Representation of a reader pairing available immediately from ReaderManager.pairReader. Provides a way to interact with an ongoing reader pairing, e.g. stop it.

ReaderChangedEvent

class ReaderChangedEvent(val change: ReaderChangedEvent.Change, val reader: ReaderInfo, val readerSerialNumber: String?)

Data provided by Mobile Payments SDK to indicate a change in a specific reader.

ReaderInfo

class ReaderInfo(val id: String, val model: ReaderInfo.Model, val status: ReaderInfo.Status, val serialNumber: String?, val name: String, val connectionType: ReaderInfo.ConnectionType, val batteryStatus: ReaderInfo.BatteryStatus?, firmwareVersion: String?, firmwarePercent: Int?, val supportedCardEntryMethods: Set<CardEntryMethod>, val isForgettable: Boolean = model == Model.CONTACTLESS_AND_CHIP, val isBlinkable: Boolean = model == Model.CONTACTLESS_AND_CHIP, val firmwareInfo: ReaderInfo.ReaderFirmwareInfo)

Provides information about an individual card reader at a given time. This is an immutable snapshot of the reader's past state, not a live model object. Updates are provided via callbacks registered via ReaderManager.setReaderChangedCallback.

ReaderManager

interface ReaderManager

Tracks changes to the set of available readers and their state; provides pairing and removal capabilities for card readers.

ReaderSettings

interface ReaderSettings

Represents reader settings that apply to all readers.

RetryConnectionResult

enum RetryConnectionResult : Enum<RetryConnectionResult>

Result of attempting to retry a connection to a card reader.

TapToPaySettings

interface TapToPaySettings